docs: resolve CS1574 unresolved crefs and CS1571 duplicate param in TodoApp.BlazorWasm.Client TodoService#2
Closed
adrianhall wants to merge 1 commit into
Closed
docs: resolve CS1574 unresolved crefs and CS1571 duplicate param in TodoApp.BlazorWasm.Client TodoService#2adrianhall wants to merge 1 commit into
adrianhall wants to merge 1 commit into
Conversation
…odoApp.BlazorWasm.Client TodoService Fixes unresolved XML doc <see cref=.../> tags and a duplicate <param> tag surfaced when building TodoApp.BlazorWasm.Client with -p:GenerateDocumentationFile=true: - ValidationException and ConcurrencyException don't exist in CommunityToolkit.Datasync.Client; the client actually throws ConflictException<T> on version/duplicate conflicts and EntityDoesNotExistException when an item is missing. Exception docs on CreateTodoItemAsync/UpdateTodoItemAsync/DeleteTodoItemAsync are updated to reference these real types. - AddAsync(T)/ReplaceAsync(T) crefs pointed at nonexistent overloads on DatasyncServiceClient<T>; the code actually calls the IDatasyncServiceClientExtensions.AddAsync/ReplaceAsync extension methods, so the crefs now target those. - RemoveAsync(string, DatasyncServiceOptions) was missing its CancellationToken parameter in the cref. - Merged the duplicate <param name="title"> tag on CreateTodoItemAsync in both files into a single tag. Fixes CommunityToolkit#550
Owner
Author
|
Closing: this PR was opened against the wrong repo (my fork's own main, adrianhall/CommunityToolkit-Datasync) instead of the upstream CommunityToolkit/Datasync repo. Re-opening correctly from the same branch. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes the CS1574 unresolved XML doc
crefwarnings and the CS1571 duplicate<param>warning reported in CommunityToolkit#550, surfaced when buildingTodoApp.BlazorWasm.Clientwith-p:GenerateDocumentationFile=true.Traced each
crefagainst the actualCommunityToolkit.Datasync.Clientsource rather than guessing:ValidationException/ConcurrencyExceptiondon't exist inCommunityToolkit.Datasync.Client, and are never actually thrown byAddAsync/ReplaceAsynctoday — a rejected/invalid write surfaces asConflictException<T>(409/412) orEntityDoesNotExistException(404, sinceDatasyncServiceOptions.ThrowIfMissingdefaults totrue), thrown by the client library itself. Updated the exception docs onCreateTodoItemAsync/UpdateTodoItemAsync/DeleteTodoItemAsyncin bothITodoService.csandTodoService.csto reference these real types instead.DatasyncServiceClient{T}.AddAsync(T)/.ReplaceAsync(T)don't exist with those signatures — the code actually calls theIDatasyncServiceClientExtensions.AddAsync/ReplaceAsyncextension methods (2-arg: entity +CancellationToken), so thecrefs now target those, mirroring the fix pattern already used forEntityFrameworkQueryableExtensions.AnyAsyncin docs: fix CS1574 XML cref for AnyAsync CommunityToolkit/Datasync#553.DatasyncServiceClient{T}.RemoveAsync(string, DatasyncServiceOptions)was just missing itsCancellationTokenparameter.<param name="title">tag onCreateTodoItemAsyncin both files into a single tag positioned after<summary>.Verification
dotnet build samples/todoapp-blazor-wasm/TodoApp.BlazorWasm.Server/TodoApp.BlazorWasm.Server.csproj -p:GenerateDocumentationFile=true— 0 errors, 0 CS1574/CS1571 warnings (previously 6). One pre-existing, unrelated WASM native-linking warning remains.dotnet restore/dotnet buildonDatasync.Toolkit.sln— succeeds, 0 warnings, 0 errors.dotnet test tests/CommunityToolkit.Datasync.Client.Test— 1432/1432 passed (the test project most relevant to the types referenced in this change).Build SamplesGitHub Actions workflow dispatched against this branch — all 17 jobs + aggregation check passed: https://github.com/adrianhall/CommunityToolkit-Datasync/actions/runs/29145912239Full solution
dotnet testwas not run end-to-end: several test projects (Cosmos, MongoDB, SQL Server, LiteDb) require live database services not available in this environment, and are unrelated to this docs-only sample change (no files undersrc/ortests/were touched).Fixes CommunityToolkit#550